fix: swagger2 validator should only report error if there's body parameter but no consume #123
Conversation
Codecov Report
@@ Coverage Diff @@
## master #123 +/- ##
==========================================
- Coverage 92.55% 92.43% -0.12%
==========================================
Files 56 56
Lines 2027 2037 +10
==========================================
+ Hits 1876 1883 +7
- Misses 151 154 +3
Continue to review full report at Codecov.
|
| const checkStatus = config.no_consumes_for_put_or_post; | ||
|
|
||
| if (checkStatus !== 'off') { | ||
| result[checkStatus].push({ | ||
| path: `paths.${pathKey}.${opKey}.consumes`, | ||
| message: | ||
| 'PUT and POST operations must have a non-empty `consumes` field.' | ||
| 'PUT and POST operations with body parameter must have a non-empty `consumes` field.' |
There was a problem hiding this comment.
Just a small wording suggestion. Might want to do this on line 2 as well
| 'PUT and POST operations with body parameter must have a non-empty `consumes` field.' | |
| 'PUT and POST operations with a body parameter must have a non-empty `consumes` field.' |
| @@ -84,7 +84,7 @@ describe('validation plugin - semantic - operations-ibm - swagger2', function() | |||
| expect(res.errors.length).toEqual(1); | |||
| expect(res.errors[0].path).toEqual('paths./CoolPath.post.consumes'); | |||
| expect(res.errors[0].message).toEqual( | |||
| 'PUT and POST operations must have a non-empty `consumes` field.' | |||
| 'PUT and POST operations with body parameter must have a non-empty `consumes` field.' | |||
There was a problem hiding this comment.
Will you also add a test exercising your changes? As in, a test where there is no consumes and no body parameter and show that there are no errors
| '/CoolPath': { | ||
| parameters: [ | ||
| { | ||
| name: 'BadParameter', |
There was a problem hiding this comment.
Poor parameter - there's something wrong with the operation, not him 😉
## [0.16.2](v0.16.1...v0.16.2) (2020-01-27) ### Bug Fixes * swagger2 validator should only report error if there's body parameter but no consume ([#123](#123)) ([1d97cb2](1d97cb2))
|
🎉 This PR is included in version 0.16.2 🎉 The release is available on: Your semantic-release bot 📦🚀 |
Currently, swagger2 validator reports error on all PUT or POST operations that has no consume field. This is technically incorrect because a POST operation is not required to have a request body and if there is no request body, there does not need to be a consumes field.
The fix now checks for body parameters on the path level and also operation level, and will only report error when there is body parameter, but no consume field.